/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.core.util;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

/**
 * 固定サイズのデータを効率良く扱うための入出力ユーティリティクラス。<br>
 * (このクラスの全てのメソッドはスレッドセーフです。)<br>
 */
public class FixedSizeIOUtil {
	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//コンストラクタ

	/**
	 * コンストラクタです。<br>
	 * (クラスメソッドのみのユーティリティークラスなので、privateにしてインスタンスを作成できないようにしています。)<br>
	 */
	private FixedSizeIOUtil() {
		//基底クラスのコンストラクタの呼び出し
		super();
	}


	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//クラスメソッド

	/**
	 * 指定されたファイルの内容をバイト配列として取得します。<br>
	 * ファイルのサイズを元にして処理を行うので、サイズが正しくない場合の動作は保証しません。<br>
	 *
	 * @param file ファイル
	 * @return バイト配列
	 * @throws IOException 入出力エラーが発生した場合
	 */
	public static byte[] toByteArray(File file) throws IOException {
		//ファイル入力ストリームのインスタンスを生成
		InputStream is = new FileInputStream(file);

		try {
			//ファイル入力ストリーム、ファイルのサイズを指定して、実際に処理を行うメソッドを呼び出す
			return toByteArray(is, (int) file.length());
		}
		//終了処理
		finally {
			//入力ストリームを確実に閉じる
			IOUtils.closeQuietly(is);
		}
	}

	/**
	 * 指定された入力ストリームの内容を指定されたサイズのバイト配列として取得します。<br>
	 * 入力ストリームの内容が指定されたサイズよりも大きい場合は、例外を投げます。<br>
	 * 入力ストリームの内容が指定されたサイズよりも小さい場合は、それ以降の部分は0が入ったバイト配列が返されます。<br>
	 *
	 * @param is 入力ストリーム
	 * @param length サイズ
	 * @return バイト配列
	 * @throws IOException 入出力エラーが発生した場合
	 */
	public static byte[] toByteArray(InputStream is, int length)
			throws IOException {
		//結果を格納するバイト配列
		byte[] byteArray = new byte[length];

		//バイト配列の次の書き込み位置
		int position = 0;

		//読み込んだバイト数
		int c = 0;

		//入力ストリームの終わりに達するまで、バイト配列にデータを読み込み続ける
		while ((c = is.read(byteArray, position, length - position)) > 0) {
			//バイト配列の次の書き込み位置を更新する
			position += c;
		}

		//指定されたサイズと実際に読み込んだバイト数がと一致しない場合
		if (length != position) {
			//例外を投げる
			throw new IOException("指定されたサイズと実際に読み込んだバイト数が一致しません。指定されたサイズ:"
					+ length + ", 実際に読み込んだバイト数:" + position + "");
		}

		//結果のバイト配列を返す
		return byteArray;
	}
}
